auかんたん決済

auかんたん決済(都度決済) API一覧

※idPass版にのみ対応しています。json版には対応しておりません。

HTTP仕様（.idPass）

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200：常に200を返却

EntryTranAu 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト
ShopID shopID 必須 半角英数13桁 固定
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

OrderID orderID 必須 半角英数記号27桁
オーダーID

JobCd jobCd 必須
処理区分

AUTH：仮売上
CAPTURE：即時売上

Amount amount 必須 半角数字7桁
利用金額

Tax tax 半角数字7桁
税送料

税送料を指定した場合は、利用金額＋税送料が決済金額となります。
利用金額＋税送料で1円以上9,999,999円以下である必要があります。

URL
/payment/EntryTranAu.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001",
  "jobCd": "AUTH",
  "amount": "1000"
}
URL
/payment/EntryTranAu.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=AUTH&Amount=1000
レスポンス
正常
AccessID accessID 半角英数32桁 固定
取引ID

AccessPass accessPass 半角英数32桁 固定
取引パスワード

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813"
}
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
レスポンスパラメータ：異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

ExecTranAu 決済実行

これ以降の決済取引で必要となるトークンを返却します。

リクエスト
ShopID shopID 必須 半角英数13桁 固定
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

AccessID accessID 必須 半角英数32桁 固定
取引ID

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

OrderID orderID 必須 半角英数記号27桁
オーダーID

SiteID siteID 半角英数13桁 固定
サイトID

会員ID指定時は必須です。

SitePass sitePass 半角英数64桁
サイトパスワード

会員ID指定時は必須です。

MemberID memberID 半角英数記号60桁
会員ID

決済する対象の会員IDを設定します。
会員IDを指定した場合は2回目以降のauログイン画面をスキップできます。

MemberName memberName 全半角255桁
会員名

登録する名前を設定します。

CreateMember createMember 半角数字1桁 固定
会員作成フラグ

会員が存在しない場合の動作を指定します。

0：登録しない。
会員が存在しない場合、エラーを返す
1：登録する。
会員が存在しない場合、新規登録する

会員ID指定時は必須です。

ClientField1 clientField1 全半角100バイト
加盟店自由項目1

ClientField2 clientField2 全半角100バイト
加盟店自由項目2

ClientField3 clientField3 全半角100バイト
加盟店自由項目3

Commodity commodity 必須 全角48バイト
摘要

お客様が購入する商品の情報を設定します。
設定可能な文字は「全角文字」です。

RetURL retURL 必須 半角英数記号256桁
決済結果戻しURL

加盟店様が当サービスからの決済結果を受信する為の結果受信URLを設定します。
KDDIセンター上でお客様が認証、支払操作をキャンセルした場合や、当サービスにて決済処理を実行した場合に指定されたURLに結果をリダイレクト経由で送信されます。

PaymentTermSec paymentTermSec 半角数字5桁
支払開始期限秒

お客様が【決済実行】から【支払手続き開始IF】を呼び出すまでの期限です。
最大86,400秒（1日）
呼び出しパラメータが空の場合、120秒で処理されます。

ServiceName serviceName 必須 全角48バイト
表示サービス名

加盟店様のサービス名称です。
設定可能な文字は「全角文字」です。

ServiceTel serviceTel 必須 半角数字記号15桁
表示電話番号

加盟店様の電話番号です。
設定可能な文字は「半角数字と"-"(ハイフン)」です。

URL
/payment/ExecTranAu.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "commodity": "摘要",
  "retURL": "https://example.com/receive",
  "serviceName": "表示サービス名",
  "serviceTel": "11111111111"
}
URL
/payment/ExecTranAu.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Commodity=摘要&RetURL=https://example.com/receive&ServiceName=表示サービス名&ServiceTel=11111111111
レスポンス
正常
AccessID accessID 半角英数32桁 固定
アクセスID

Token token 半角英数記号256桁
トークン

アクセスIDのハッシュ値を返却します。

StartURL startURL 半角英数記号256桁
支払手続き開始IFのURL

支払手続き開始IFのURLを返却します。

StartLimitDate startLimitDate 半角数字14桁 固定
支払開始期限日時

支払手続き開始IFの呼び出し期限を返却します。
yyyyMMddHHmmss書式

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "token": "RJoe1sBnLLL4/+9FzD37cHGkMa9lQgEKs3XSTwdC3PqwBS7yYvxSiC0zeMVH+O4F",
  "startURL": "https://x01.mul-pay.jp/payment/AuStart.idPass",
  "startLimitDate": "20220722112429"
}
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=RJoe1sBnLLL4/+9FzD37cHGkMa9lQgEKs3XSTwdC3PqwBS7yYvxSiC0zeMVH+O4F&StartURL=https://x01.mul-pay.jp/payment/AuStart.idPass&StartLimitDate=20220722112429
レスポンスパラメータ：異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

AuStart 支払手続き開始IFの呼び出し

auかんたん決済において、お客様をKDDIセンターのau ID認証画面へと遷移させる必要があります。
※取引が特定できない場合、すでに支払いを済ませている場合、支払期限切れの場合等はエラー画面を表示します。

リクエスト
AccessID accessID 必須 半角英数32桁 固定
取引ID

Token token 必須 半角英数記号256桁
トークン

URL
/payment/AuStart.json
リクエストパラメータ
{
	"accessID": "a6a6b0061347e90cdef806b39bd28705",
	"token": "RJoe1sBnLLL4/+9FzD37cHGkMa9lQgEKs3XSTwdC3PqwBS7yYvxSiC0zeMVH+O4F"
  }
URL
/payment/AuStart.idPass
リクエストパラメータ
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=RJoe1sBnLLL4/+9FzD37cHGkMa9lQgEKs3XSTwdC3PqwBS7yYvxSiC0zeMVH+O4F
リダイレクトページサンプル

  <html>
	<head>
	  <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
	</head>
	<body OnLoad='OnLoadEvent();'>
	  <form name="AuStartCall" action="{決済実行のレスポンスで返却した接続先URL}" method="POST">
	  <noscript>
		<br>
		<br>
		<center>
		  <h2>
		  auの決済画面へ遷移します。
		  </h2>
		  <input type="submit" value="続行">
		</center>
		</noscript>
		<input type="hidden" name="AccessID" value="{AccessID}">
		<input type="hidden" name="Token" value="{Token}">
	  </form>
	  <script>
	  <!--
		function OnLoadEvent() {
		  document.AuStartCall.submit();
		}
	  //-->
	  </script>
	  </body>
  </html>

決済結果受信

KDDIセンターから、当サービスに認証・支払操作結果が通知されます。
認証・支払操作結果は、お客様が支払操作を完了した場合と認証・支払操作をキャンセルした場合に通知されます。
※ブラウザを×ボタンで閉じた場合は、通知されません。
当サービスは、【決済実行】時に指定されたリダイレクトURLに決済結果を通知します。

レスポンス
正常
ShopID shopID 半角英数13桁 固定
ショップID

OrderID orderID 半角英数記号27桁
オーダーID

Status status
現状態

該当取引の取引状態を返却します。

AUTHPROCESS：認証中
AUTH：仮売上
CAPTURE：即時売上
PAYFAIL：決済失敗

※お客様がauかんたん決済の画面で支払方法にWebMoneyを選択し決済が成功した場合、現状態は即時売上になります。

TranDate tranDate 半角数字14桁 固定
処理日時

当サービスで処理を実施した日時を返却します。当サービスで処理を実施した日時を返却します。
yyyyMMddHHmmss書式

PayInfoNo payInfoNo 半角数字16桁 固定
決済情報番号

オーソリ処理が正常終了した時に振り出される番号です。

お客様がau ID画面で確認できます。

PayMethod payMethod 半角数字2桁 固定
支払方法

支払方法です。

01：合算
02：クレジットカード
03：WebMoney
05：au PAY 残高（※）
06：au PAY カード（※）

お客様がau ID画面で確認できます。
※05、06はau随時契約がある場合のみ返却され、契約が無い場合は01が返却されます。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード

AuCancelReturn 決済キャンセル・返品

決済が完了した取引に対して決済内容のキャンセル・返品を行います。

リクエスト
ShopID shopID 必須 半角英数13桁 固定
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

AccessID accessID 必須 半角英数32桁 固定
取引ID

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

OrderID orderID 必須 半角英数記号27桁
オーダーID

CancelAmount cancelAmount 必須 半角数字7桁
キャンセル金額

キャンセル金額＋キャンセル税送料をキャンセル金額とします。（1円以上）

キャンセル金額はオーソリ時の金額を指定してください。
※0円の場合はエラーとします。
※精算後（売上確定した翌月以降）のキャンセルのみ一部返品可能です。

例）請求525円より全額キャンセル→
キャンセル金額：525
請求525円より210円分キャンセル→キャンセル金額：210

CancelTax cancelTax 半角数字7桁
キャンセル税送料

URL
/payment/AuCancelReturn.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "cancelAmount": "1000"
}
URL
/payment/AuCancelReturn.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&CancelAmount=1000
レスポンス
正常
OrderID orderID 半角英数記号27桁
オーダーID

Status status
現状態

キャンセル・返品成功時は以下のステータスが返却されます。
・CANCEL：キャンセル
・RETURN：返品

キャンセル・返品失敗時はキャンセル・返品処理前のステータスが返却されます。

Amount amount 半角数字7桁
利用金額

利用金額からキャンセル金額を減算した結果を返却します。

例）利用金額5000円よりキャンセル金額3000円 => 利用金額2000円

Tax tax 半角数字7桁
税送料

税送料からキャンセル税送料を減算した結果を返却します。

例）税送料250円よりキャンセル税送料150円 => 税送料100円

CancelAmount cancelAmount 半角数字7桁
キャンセル金額

CancelTax cancelTax 半角数字7桁
キャンセル税送料

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "orderID": "ORDER0000001",
  "status": "CANCEL",
  "amount": "1000",
  "tax": "-",
  "cancelAmount": "1000",
  "cancelTax": ""
}
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=CANCEL&Amount=1000&Tax=0&CancelAmount=1000&CancelTax=0
レスポンスパラメータ：異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

AuSales 実売上

仮売上の決済に対して実売上を行います。尚、実行時に仮売上時との金額チェックを行います。

リクエスト
ShopID shopID 必須 半角英数13桁 固定
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

AccessID accessID 必須 半角英数32桁 固定
取引ID

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

OrderID orderID 必須 半角英数記号27桁
オーダーID

Amount amount 必須 半角数字7桁
利用金額

Tax tax 半角数字7桁
税送料

利用金額＋税送料が売上金額となります（1円以上）
※0円の場合はエラーとします。
※オーソリ時より大きい金額の場合はエラーとします。
※オーソリ時と異なる金額の場合は、指定された金額で売上を確定します。

URL
/payment/AuSales.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "amount": "1000"
}
URL
/payment/AuSales.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1000
レスポンス
正常
OrderID orderID 半角英数記号27桁
オーダーID

Status status
現状態

売上確定成功時は以下のステータスが返却されます。
・SALES：実売上

売上確定失敗時は売上確定処理前のステータスが返却されます。

Amount amount 半角数字7桁
利用金額

売上確定した利用金額を返却します。

Tax tax 半角数字7桁
税送料

売上確定した税送料を返却します。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "orderID": "ORDER0000001",
  "status": "SALES",
  "amount": "1000",
  "tax": "-"
}
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=SALES&Amount=1000&Tax=0
レスポンスパラメータ：異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

DeleteAuOpenID OpenID解除

サイトID、会員IDを指定し、該当会員のOpenID解除を行います。 お客様のサービス停止や新しいOpenIDの取得が必要になった場合に、OpenID解除を行ってください。

リクエスト
SiteID siteID 必須 半角英数13桁 固定
サイトID

SitePass sitePass 必須 半角英数64桁
サイトパスワード

MemberID memberID 必須 全半角60桁
会員ID

OpenIDを解除する会員IDを指定します。

URL
/payment/DeleteAuOpenID.json
リクエストパラメータ
{
  "siteID": "tsite11223344",
  "sitePass": "PASSWORD",
  "memberID": "membereid"
}
URL
/payment/DeleteAuOpenID.idPass
リクエストパラメータ
SiteID=tsite11223344&SitePass=PASSWORD&MemberID=membereid
レスポンス
正常
SiteID siteID 半角英数13桁 固定
サイトID

OpenID解除が正常終了の場合は指定されたSiteIDが返却されます。

MemberID memberID 全半角60桁
会員ID

OpenID解除が正常終了の場合は指定されたMemberIDが返却されます。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "siteID": "tsite11223344",
  "memberID": "memberid"
}
レスポンスパラメータ：正常系
SiteID=tsite11223344&MemberID=memberid
レスポンスパラメータ：異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

指定したオーダーIDの取引情報を取得します。

リクエスト
ShopID shopID 必須 半角英数13桁 固定
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

OrderID orderID 必須 半角英数記号27桁
オーダーID

PayType payType 必須 半角数字2桁
決済方法

8：auかんたん決済

URL
/payment/SearchTradeMulti.json
リクエストパラメータ
{
	"shopID": "tshop11223344",
	"shopPass": "PASSWORD",
	"orderID": "ORDER0000001",
	"payType": "8"
  }
URL
/payment/SearchTradeMulti.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=8
レスポンス
正常
Status status
現状態

UNPROCESSED：未決済
REQSUCCESS：要求成功
AUTHPROCESS：認証処理中
AUTH：仮売上
SALES：実売上
CAPTURE：即時売上
PAYFAIL：決済失敗
CANCEL：キャンセル
RETURN：返品

ProcessDate processDate 半角数字14桁 固定
処理日時

処理を実施した日時を返却します。
yyyyMMddHHmmss書式

JobCd jobCd
処理区分

AUTH：仮売上
SALES：実売上
CAPTURE：即時売上
CANCEL：キャンセル
RETURN：返品

AccessID accessID 半角英数32桁 固定
取引ID

AccessPass accessPass 半角英数32桁 固定
取引パスワード

Amount amount 半角数字10桁
利用金額

決済または決済依頼をした金額を返却します。

Tax tax 半角数字10桁
税送料

Currency currency 3桁 固定
通貨コード

決済に利用された通貨を返却します。

SiteID siteID 半角英数13桁 固定
サイトID

MemberID memberID 全半角60桁
会員ID

ClientField1 clientField1 全半角100バイト
加盟店自由項目1

ClientField2 clientField2 全半角100バイト
加盟店自由項目2

ClientField3 clientField3 全半角100バイト
加盟店自由項目3

PayType payType 半角数字2桁
決済方法

8：auかんたん

AuPayInfoNo auPayInfoNo 半角数字16桁 固定
au決済情報番号

購入に使用されたauかんたん決済の管理番号

お客様がau ID画面で確認できます。

AuPayMethod auPayMethod 半角数字2桁 固定
au支払方法

購入に使用されたauかんたん決済の支払方法

AuCancelAmount auCancelAmount 半角数字7桁
キャンセル金額

キャンセル・返品した金額を返却します。

AuCancelTax auCancelTax 半角数字7桁
キャンセル税送料

キャンセル・返品した税送料を返却します。

AuAcceptCode auAcceptCode 半角英数14桁 固定
au承諾番号

随時決済時に指定されたau承諾番号を返却します。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
	"status": "SALES",
	"processDate": "20220722112429",
	"jobCd": "AUTH",
	"accessID": "a6a6b0061347e90cdef806b39bd28705",
	"accessPass": "5e0e54b892e14ed03e8cf807a6053813",
	"amount": "1000",
	"tax": "",
	"currency": "",
	"siteID": "",
	"memberID": "",
	"clientField1": "",
	"clientField2": "",
	"clientField3": "",
	"payType": "8",
	"auPayInfoNo": "20b0c44298fc1c14",
	"auPayMethod": "01",
	"auCancelAmount": "",
	"auCancelTax": "",
	"auAcceptCode": ""
  }
レスポンスパラメータ：正常系
Status=SALES&ProcessDate=20220722112429&JobCd=AUTH&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=1000&Tax=0&Currency=&SiteID=&MemberID=&ClientField1=&ClientField2=&ClientField3=&PayType=8&AuPayInfoNo=2000044298001014&AuPayMethod=01&AuCancelAmount=0&AuCancelTax=0&AuAcceptCode=
レスポンスパラメータ：異常系
{
	  "errCode":"E01",
	  "errInfo":"E01040001"
  }
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001